Using Interface Options
1. In order to use any of the next day freight interfaces the Synchronize NetConnect field must be set to Y (Y=Yes). This will open the other fields so that their values can be set.
2. When you first enter the Interface Options function command options will appear:
- Change – Select Change to make changes.
- Exit – Select Exit to exit the Interface Options function.
Select Change.
3. Set the Synchronize NetConnect field to Y (Y=Yes) to activate the NetConnect Processing and then activate the next day carrier services.
4. Enter the NetConnect DSN (database source name) used to interface NetConnect with the next day carrier system. The default ID is NetConnect.
5. Specify the processing interval, in seconds, for the polling of the external databases. A normal value for this field would be between 10 to 60 seconds, with longer periods of time applicable for users who do not interface on a regular basis.
Note: The smaller the Processing Interval, the more frequently the system will check for new items to process. However, setting the value too low will cause needless system traffic, and may bog down your network.
6. Once NetConnect has been turned on, the next day freight interfaces may be turned on (may be used concurrently), including:
- FedEx – An interface with the FedEx shipping system
- UPS – An interface with the UPS shipping system
- DHL – An interface with the DHL shipping system.
Note: Setting up each of these services requires system setups outside of the Net•Yield system by the service provider. The installation and configuration of these services is outside the scope of this manual. The configuration steps for Net•Yield are listed below.
To turn on any of these connections, set the appropriate flag(s) to Y (Y=Yes). One, several, or all of the electronic interfaces may be set to Y.
7. Set the EDI File Creation to Normal or Compact. Normal is the recommended setting. The Compact setting strips out all blank segments.
8. To activate the enhanced lot source product lot attributes features of Net•Yield enter your Net•Yield License Number found in License Registration the Company ID Trace Field. If you subscribe to Trace Register, enter your Trace Register account number in the Company ID Trace field. By entering an account number, the system will activate the ability to record the source product lot attributes from your vendor and automatically create and send the XML Import Trace Documents needed for Trace Register at the time of invoicing when the Keep Invoice yes option is selected in Sales Orders, Shipping, Dispatching and Invoicing, or the sales order is in a shipped or ready status See Trace Overview for more information.
9. If you subscribe to the TraceRegister service, Enter the API login Key assigned to your company by TraceRegister to automatically upload the XML Import Trace Document to the Trace Register website. See Trace Overview for more information.
10. Enter the API URL web address to connect to the TraceRegister service import document service.
11. Enter the XML Schema used to validate that the XML Import Trace document was properly formatted. The current schema is .import_spec.xsd
12. Select which option to use to create the Trace XML Import Document. Select O = Order is updated with a status of Shipped or Ready to create and send the trace document when an order has been updated to a Shipped or Ready status in Sales Orders, Shipping or Update Pick List, I = Invoices are kept to create and send the trace document when an order has been invoiced and kept in Sales Orders, Shipping, Dispatching or Invoicing. An amended trace document will be sent when the invoice is kept if option O is used, N= Not using, which will create the XML Import Trace Document when the invoice is kept but send it automatically. See Trace Overview for more information.
13. Select P = prevent empty values to prevent the update of the item info attributes needed to record the Trace source product lot attributes is not entered when the item is received in Purchasing or Receiving Purchase Orders. The Purchase Order will not be received if any of the required information is missing. Select W= warn on empty values to warn the user that he item info attributes needed to record the Trace source product information is not entered when the item is received in Purchasing or Purchase Orders. The user will be warned that required information is missing but can still receive and update the Purchase Order even if any of the required information is missing, N=not using - do not validate if lot attributes are missing. See Trace Overview for more information.
14. Select Update to save the changes that were made.
Important: Your changes will not be saved unless you select Update.
Set the system settings needed for next day freight interface via NetConnect Processing
- Attach the NetConnect database as described in Using NetConnect Processing.
- Set up a database source name (DSN) for the NetConnect database, as described in NetConnect Processing.
- Create next day freight classes based on the service type and codes assigned by the next day freight carrier.
- Create carton-type items for the shipping cartons that will be used by the next day freight carrier.
- Create sales-type cost adjustments for each type of service offered by the next day freight carrier as a next day freight class.
- In Ledger Options, enter the account number used for next day carriers using NetConnect.
- Set the Cartonize, Carton Label, and Next Day Label settings in Shipping Options to Y (Y=Yes) in order to generate the carton labels needed for the next day freight service option.
- The freight type for the next day carrier must be set to N (N=next day) in the Carrier table.
- The route for the next day carrier selected must be defined as "next day".
- Enter the next day carrier account number for the customer, if the freight terms for the customer is set to collect freight charges.
- If there is more than one next day carrier or more than one device for the next day carrier, set the workstation ID in User Options for the user to point to the correct device. The workstation ID must be the same for each carrier.
The NetConnect interface works the same way regardless of the next day carrier. Net•Yield will send the sales order header information: customer name, ship to address, city, state, zip code, and country to the third party next day freight system based on the freight type assigned to the sales order. The next day freight class will be used to determine the next day freight carrier, service type, service class, and shipper release instructions for the sales order. The carton dimensions for the carton assigned to the order, along with the net weight shipped and the carton tare weight for each carton, will also be sent to next day freight carrier’s system to determine the freight charges for the carton. The declared value for the items ordered for each box, the COD value of the order, and customer’s terms, will be sent to the carrier to notify them of the amount of the shipment. They will also be notified whether or not the shipment is COD and whether cash, a company check, a bank check, or secured check should be collected for the delivery. The next day freight system will assign and print a shipping label, return the tracking number, and provide a total charge per carton to Net•Yield.
Changes to a sales orders will result in the label being voided and a new label and tracking number will be issued by the carrier. Changes to the carton label done in the next day carrier’s system will result in a voided label in Net•Yield.
Creating the next day freight records
On update in Sales Orders, Shipping, or Order Control, if the Cartonize setting and the Next Day Label setting are set to Y (Y=Yes) in Shipping Options, and the sales order has been cartonized, a window will pop displaying the following information:
- Printed – A Y (Y=Yes)/N (N=no) flag indicating the label carton information has been sent to the next day freight system and has been processed
- # – The box/label number for the sales order
- Carton – The carton name for the carton assigned to the sales order when the order was cartonized
- Gross Weight – The gross weight of the carton
- Tracking No – The UPS tracking number for the carton
- Charge – The total freight charge for the carton.
The following message will display: "Press enter to tag the (service type name)." Press Enter to tag the carton to produce Net•Yield carton labels, if required, or press F10 to exit. New carton labels will automatically be marked with an asterisk (*) to indicate they have not been processed by the next day freight service. To exclude the carton label from being sent to the next day freight service, remove the asterisk by scrolling to the line and pressing Enter.
Shipping Systems Engineers: Use the following specifications for interfacing with various systems:
FedEx
NetConnect Interface Flag sets at the SQL transaction level FedEx:
Net•Yield places records in the FedExLabel file based on the Processing Interval setting in Interface Options. The records number is the sales order number plus the box number generated when the items on the sales order were cartonized. Status 1 records are new records that FedEx has never seen before. FedEx should print one label for each record, generate the tracking number, calculate the freight charges, and change the status to 2.
Status 2 records have been processed by FedEx and are ready for Net•Yieldto update the tracking number and add the charges to the sales order. The status 2 records will stay in the FedExLabel file for approximately 24 hours.
Status 3 records are created when a user voids a label in Net•Yield, Net•Yield and replaces that status 2 record in the FedExLabel file with a status 3. FedEx will only see a status 3 if FedEx first provided the status 2 from a status 1. FedEx should void the original label, change the status from 3 to 4, provide the void tracking number, and zero the charge.
Status 4 records are created when a user voids a record directly in the FedEx system that was originally requested by Net•Yield and printed by FedEx. FedEx should do the following:
- find the original record as a status 2
- replace its status with 4
- provide the voided tracking number
- zero the charge.
FedEx only looks for status 1 and status 3 records provided by Net•Yield. 1s become 2s after the label is printed, 3s become 4s after the label is voided. Net•Yield only looks for status 2 and status 4 records provided by FedEx. For FedEx initiated voids, 2s become 4s.
Each time the FedExLabel file is updated, the previous file is deleted and replaced with a new copy that contains all FedEx records.
Schema FedEx Label:
| Field |
Type |
Description |
| Label Order |
C 10 |
The Net•Yield unique ID used to link the transaction in both systems. It is the sales order number plus the box number |
| Order Number |
N 6 |
The Net•Yield sales order number |
| Station |
C 2 |
The FedEx workstation ID for the computer running the FedEx next day freight system |
| Status |
C 1 |
1 = new request from Net•Yield; 2 = request responded to by FedEx; 3 = void request from Net•Yield; 4 = void responded to by FedEx |
| PoNumber |
C 15 |
The customer purchase order number, if applicable |
| AirBill |
C 10 |
The customer's airbill or other tracking reference number entered on the sales order |
| Company |
C 40 |
The customer ship-to name |
| Contact |
C 40 |
The ship-to contact |
| Address 1 |
C 40 |
The ship-to address line 1 |
| Address 2 |
C 40 |
The ship-to address line 2 |
| City |
C 25 |
The ship-to city |
| State |
C 2 |
The ship-to state |
| Zip Code |
C 10 |
The ship-to zip code |
| Country |
C 15 |
The ship-to country |
| Phone |
C 14 |
Customer phone number 1, the customer ship-to phone, or the one time address phone |
| Weight |
N (8, 4) |
The weight of the product plus carton tare |
| Tare Weight |
N (8, 4) |
The tare weight of the empty carton |
| Declared |
N (12, 4) |
The declared value equals the total value of the items in the carton X the declared value percentage for the service type. |
| Service Type |
C 1 |
The service type ID for the type of service. |
| Service Class |
C 1 |
The service class ID used to identify whether the service is commercial or residential |
| Shipper Release |
C 1 |
The shipper release ID to determine whether the shipment needs/does not need a signature in order to be dropped off |
| Carton Length |
N (8, 4) |
The length of the carton based on the carton length fields of the carton item assigned to the sales order |
| Carton Width |
N (8, 4) |
The width of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Carton Height |
N (8, 4) |
The height of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Package |
C 1 |
Package Type 1 = customer provided packaging. |
| Billing |
C 1 |
1 = bill sender, 3 = bill recipient (account provided) |
| Account |
C 16 |
If Billing = 1 or 3, the billing account number |
| COD Amount |
N (12, 4) |
The total invoice value for the carton |
| COD |
C 1 |
Y = collect the COD amount, N = no, do not collect the COD amount. |
| COD Freight Added |
C 1 |
Y = collect COD amount and freight charges, N = no, do not collect COD amount and freight charges. |
| COD Tender By |
C 1 |
1 = bank or secured check, 2 = company check based on customer terms. |
| Email |
C 60 |
The first email address of the customer recipient with confirm to role, the customer ship-to email address, or the one time address email, if the Email flag is set to Y (Y=Yes) |
| Email Flag |
C 1 |
Y = send email, N = no, do not send email |
| Tracking |
C 20 |
The FedEx package tracking number |
| Charges |
N (8, 2) |
The FedEx total freight charges for the package/carton. |
UPS
NetConnect Interface Flag sets at the SQL transaction level UPS:
Net•Yield places records in the UpsLabel file based on the Processing Interval setting in Interface Options. The records number is the sales order number plus the box number generated when the items on the sales order were cartonized. Status 1 records are new records that UPS has never seen before. UPS should print one label for each record, generate the tracking number, calculate the freight charges, and change the status to 2.
Status 2 records have been processed by UPS and are ready for Net•Yieldto update the tracking number and add the charges to the sales order. The status 2 records will stay in the UpsLabel file for approximately 24 hours.
Status 3 records are created when a user voids a label in Net•Yield, Net•Yield replaces that status 2 record in the UpsLabel file with status 3. UPS will only see a status 3 if UPS first provided the status 2 from a status 1. UPS should void the original label, change the status from 3 to 4, provide the void tracking number, and zero the charge.
Status 4 records are created when a user voids a record directly in the UPS system which was originally requested by Net•Yield and printed by UPS. UPS should do the following:
- find the original record as a status 2
- replace its status with 4
- provide the voided tracking number
- zero the charge.
UPS only looks for status 1 and status 3 records provided by Net•Yield. 1s become 2s after the label is printed, 3s become 4s after the label is voided. Net•Yield only looks for status 2 and status 4 records provided by UPS. For UPS initiated voids, 2s become 4s.
Each time the UpsLabel file is updated, the previous file is deleted and replaced with a new copy that contains all UPS records.
Schema UPS Label
| Field |
Type |
Description |
| Label Order |
C 10 |
The Net•Yield unique ID used to link the transaction in both systems. It is the sales order number plus the box number |
| Order Number |
N 6 |
The Net•Yield sales order number |
| Station |
C 2 |
The UPS workstation ID for the computer running the UPS next day freight system |
| Status |
C 1 |
1 = new request from Net•Yield; 2 = request responded to by UPS; 3 = void request from Net•Yield; 4 = void responded to by UPS. |
| PoNumber |
C 15 |
The customer purchase order number, if applicable |
| AirBill |
C 10 |
The customer's airbill or other tracking reference number entered on the sales order |
| Company |
C 40 |
The customer ship-to name |
| Contact |
C 40 |
The ship-to contact |
| Address 1 |
C 40 |
The ship-to address line 1 |
| Address 2 |
C 40 |
The ship-to address line 2 |
| City |
C 25 |
The ship-to city |
| State |
C 2 |
The ship-to state |
| Zip Code |
C 10 |
The ship-to zip code |
| Country |
C 15 |
The ship-to country |
| Phone |
C 14 |
Customer phone number 1, the ship-to customer phone, or the one time address phone |
| Weight |
N (8, 4) |
The weight of the product plus carton tare |
| Tare Weight |
N (8, 4) |
The tare weight of the empty carton |
| Declared |
N (12, 4) |
The declared value equals the total value of the items in the carton X the declared value percentage for the service type. |
| Service Type |
C 1 |
The service type ID for the type of service. |
| Service Class |
C 1 |
The service class ID used to identify whether the service is commercial or residential |
| Shipper Release |
C 1 |
The shipper release ID to determine whether the shipment needs/does not need a signature in order to be dropped off |
| Carton Length |
N (8, 4) |
The length of the carton based on the carton length fields of the carton item assigned to the sales order |
| Carton Width |
N (8, 4) |
The width of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Carton Height |
N (8, 4) |
The height of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Package |
C 1 |
Package Type 1 = customer provided packaging. |
| Billing |
C 1 |
1 = bill sender, 3 = bill recipient (account provided) |
| Account |
C 16 |
If Billing = 1 or 3, the billing account number |
| COD Amount |
N (12, 4) |
The total invoice value for the carton |
| COD |
C 1 |
Y = collect the COD amount, N = no, do not collect the COD amount. |
| COD Freight Added |
C 1 |
Y = collect COD amount and freight charges, N = no, do not collect COD amount and freight charges. |
| COD Tender By |
C 1 |
1 = bank or secured check, 2 = company check based on customer terms. |
| Email |
C (60) |
The first email address of the customer recipient with confirm to role, the customer ship-to email address, or the one time address email, if the Email flag is set to Y (Y=Yes) |
| Email Flag |
C 1 |
Y = send email, N = no, do not send email |
| Tracking |
C 20 |
The UPS package tracking number |
| Charges |
N (8, 2) |
The UPS total freight charges for the package/carton |
DHL
NetConnect Interface Flag sets at the SQL transaction level DHL:
Net•Yield places records in the UpsLabel file based on the Processing Interval setting in Interface Options. The records number is the sales order number plus the box number generated when the items on the sales order were cartonized. Status 1 records are new records that DHL has never seen before. DHL should print one label for each record, generate the tracking number, calculate the freight charges, and change the status to 2.
Status 2 records have been processed by DHL and are ready for Net•Yieldto update the tracking number and add the charges to the sales order. The status 2 records will stay in the DHLLabel file for approximately 24 hours.
Status 3 records are created when a user voids a label in Net•Yield, Net•Yield replaces that status 2 record in the DHLLabel file with status 3. DHL will only see a status 3 if DHL first provided the status 2 from a status 1. DHL should void the original label, change the status from 3 to 4, provide the void tracking number, and zero the charge.
Status 4 records are created when a user voids a record directly in the DHL system which was originally requested by Net•Yield and printed by DHL, then DHL should do the following:
- find the original record as a status 2
- replace its status with 4
- provide the voided tracking number
- zero the charge.
DHL only looks for status 1 and status 3 records provided by Net•Yield. 1s become 2s after the label is printed, 3s become 4s after the label is voided. Net•Yield only looks for status 2 and status 4 records provided by DHL. For DHL initiated voids, 2s become 4s.
Each time the DHL Label file is updated, the previous file is deleted and replaced with a new copy that contains all DHL records.
Schema DHL LABEL:
| Field |
Type |
Description |
| Label Order |
C 10 |
The Net•Yield unique ID used to link the transaction in both systems. It is the sales order number plus the box number
|
| Order Number |
N 6 |
The Net•Yield sales order number
|
| Station |
C 2 |
The DHL workstation ID for the computer running the DHL next day freight system |
| Status |
C 1 |
1 = the new request from Net•Yield; 2 = request responded to by DHL; 3 = void request from Net•Yield; 4 = void responded to by DHL.
|
| PoNumber |
C 15 |
The customer purchase order number, if applicable |
| AirBill |
C 10 |
The customer's airbill or other tracking reference number entered on the sales order |
| Company |
C 40 |
The customer ship-to name |
| Contact |
C 40 |
The ship-to contact |
| Address 1 |
C 40 |
The ship-to address line 1 |
| Address 2 |
C 40 |
The ship-to address line 2 |
| City |
C 25 |
The ship-to city |
| State |
C 2 |
The ship-to state |
| Zip Code |
C 10 |
The ship-to zip code |
| Country |
C 15 |
The ship-to country |
| Phone |
C 14 |
Customer phone number 1, the ship-to customer phone, or the one time address phone |
| Weight |
N (8, 4) |
The weight of the product plus carton tare |
| Tare Weight |
N (8, 4) |
The tare weight of the empty carton |
| Declared |
N (12, 4) |
The declared value equals the total value of the items in the carton X the declared value percentage for the service type. |
| Service Type |
C 1 |
The service type ID for the type of service. |
| Service Class |
C 1 |
The service class ID used to identify whether the service is commercial or residential |
| Shipper Release |
C 1 |
The shipper release ID to determine whether the shipment needs/does not need a signature in order to be dropped off |
| Carton Length |
N (8, 4) |
The length of the carton based on the carton length fields of the carton item assigned to the sales order |
| Carton Width |
N (8, 4) |
The width of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Carton Height |
N (8, 4) |
The height of the carton based on the carton length fields of the carton item assigned to the sales order. |
| Package |
C 1 |
Package Type 1 = customer provided packaging. |
| Billing |
C 1 |
1 = bill sender, 3 = bill recipient (account provided) |
| Account |
C 16 |
If Billing = 1 or 3, the billing account number |
| COD Amount |
N (12, 4) |
The total invoice value for the carton |
| COD |
C 1 |
Y = collect the COD amount, N = no, do not collect the COD amount. |
| COD Freight Added |
C 1 |
Y = collect COD amount and freight charges, N = no, do not collect COD amount and freight charges. |
| COD Tender By |
C 1 |
1 = bank or secured check, 2 = company check based on customer terms. |
| Email |
C 60 |
The first email address of the customer recipient with confirm to role, the customer ship-to email address, or the one time address email, if the Email flag is set to Y (Y=Yes) |
| Email Flag |
C 1 |
Y = send email, N = no, do not send email |
| Tracking |
C 20 |
The DHL package tracking number |
| Charges |
N (8, 2) |
The DHL total freight charges for the package/carton |
Use the Available Actions link below for further information.
Security Required : System - System Administration